"注解"在Android中的简单使用

我们在Android中经常会看到类似下面的代码

private Button mButton;
mButton = (Button) findViewById(R.id.button);

这是获取Button实例的老套路,看起来还算简单,但是我们每添加一个控件就要调用findViewById方法,很碍眼有某有?

那再来看看下面这个

@ViewInject(R.id.button)
private Button mButton;

这是在定义变量时使用的,并且不用再调用findViewById就得到了Button实例,这就是注解。

下面我们就来看看这是如何实现的。

在Java中,通过反射,可以知道每一个类的详细信息,比如有什么字段、方法、类名等,那么我们通过注解和反射配合,使用反射调用类中的方法,然后读取注解的参数来进行方法的执行。简单的说,我们还是会调用findViewById这个方法,但是,这个方法放到工具类中执行,我们只需要像上面那样给出参数就行了。

那么我们如何自定义注解呢,很简单,看代码

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface  ViewInject{
    int value();
}

看起来很眼熟是吧?对的,我们就仅仅在接口的interface关键字前面加一个@而已.

我们看到注解上面还有两行代码,这里分别解释下:
@Target的意思是我们注解作用的目标,这里是ElementType.FIELD,也就是作用于字段的
ElementType的类型有以下几种:
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述字段
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

@Retention的意思是注解的运行级别
RetentionPolicy的类型有以下几种
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在运行时有效(即运行时保留)

@interface则是表明这个类是一个注解,@号不能漏掉,否则变成了接口了。

注解定义好了,但是我们却不能直接使用,这需要绑定一个工具类,实现的核心就是利用反射,下面上代码:

public class AnnotateUtils {

    /**
     * 静态方法方便调用
     * @param aActivity
     */
    public static void annotate(Activity aActivity){
        Class<? extends Activity> obj = aActivity.getClass();
        //方法返回一个数组的Field对象 包括 public, protected,default(包)访问和private 字段,但不包括继承的字段。
        Field[] fileds = obj.getDeclaredFields();
        //遍历,获取注解
        for(Field field : fileds){
            //得到ViewInject注解实例 如果没有就返回null
            ViewInject viewInject = field.getAnnotation(ViewInject.class);
            if(viewInject != null){
                //得到我们使用注解时所输入的值,也就是我们的控件ID
                int viewId = viewInject.value();
                if(viewId != -1){
                    try {
                        //得到Activity的方法findViewById,第二个参数是此方法的形参类型
                        Method method = obj.getMethod("findViewById",int.class);
                        //第一个参数是调用此方法的对象,第二个参数是此方法的形参,当然这是一个可变参数
                        Object resView = method.invoke(aActivity,viewId);
                        //如果成员变量为private,必须进行此操作
                        field.setAccessible(true);
                        //将指定对象变量上此 Field 对象表示的字段设置为指定的新值。
                        field.set(aActivity,resView);
                    } catch (NoSuchMethodException e) {
                        e.printStackTrace();
                    } catch (InvocationTargetException e) {
                        e.printStackTrace();
                    } catch (IllegalAccessException e) {
                        e.printStackTrace();
                    }
                }
            }
        }
    }
    
}

注释很详细,这里我就不再解释了。

我们来看下如何使用的

public class Text extends AppCompatActivity  {

    @ViewInject(R.id.button)
    private Button mButton;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_loader_text);
        AnnotateUtils.annotate(this);
        mButton.setOnClickListener(v ->
            Toast.makeText(this, "你点击了按钮", Toast.LENGTH_SHORT).show()
        );
    }

}

最后,有几点说明:

①如果注解中的值不是value,那么在进行注解是时候,需要给出对应的值的名字,假如我们在注解中做了如下定义:

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface  ViewInject{
   int id();
}

那么在注解的时候,需要这样:

@ViewInject(id = R.id.button)
private Button mButton;

因为value这个名字是默认的,如果我们定义为value,那么注解的时候可以省略
②注解还可以帮我们注入布局,设置监听等,这是一个很有意思的东西。
③使用注解的时候,句末不能加“;”

笔者能力有限,不足之处欢迎指出。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271

推荐阅读更多精彩内容